home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / gemxx19.zoo / gem++19 / man / gemr.man < prev    next >
Text File  |  1993-09-01  |  3KB  |  84 lines
  1.                      GEM++ - C++ LIBRARIES FOR GEM/AES/VDI
  2.  
  3.  
  4.  
  5. NAME
  6.      GEMrsc - RSC file loader.
  7.  
  8. DESCRIPTION
  9.      RSC files should always be used - they allow easy translation of
  10.      your program into other languages, and user configuration of form
  11.      shape and colour.  No language-specific text needs to appear in
  12.      your program.
  13.  
  14.      Normally, GEM only allows one RSC file to be loaded at any time.
  15.      Also, each RSC file is limited to 64K in size.  This class allows
  16.      any number of RSC files to be loaded, although each is still
  17.      limited to 64K since RSC editors cannot produce large resources.
  18.  
  19. CONSTRUCTORS
  20.      GEMrsc(const char *filename, int rscw, int rsch)
  21.        Create a GEMrsc by loading the given filename.  The GEMrsc can
  22.        then be used when creating forms, alerts, etc.  The objects in
  23.        the forms of the resource are proportionally scaled as if the
  24.        RSC file was editted while the character size was the given
  25.        width and height.  For example, if the RSC was created while
  26.        in STHigh (or any TT mode) resolution, use rscw=8, rsch=16.
  27.        Note that trees containing TITLE objects are assumed to be
  28.        menus, and are repositioned using the standard GEM rescaler.
  29.  
  30.      GEMrsc(const char *filename)
  31.        Create a GEMrsc by loading the given filename using the standard
  32.        GEM rsrc_load() function.  Only ONE GEMrsc created in this way
  33.        may exist at any one time.  Also, the standard object repositioning
  34.        and resizing technique is used... yuck.
  35.  
  36. METHODS
  37.      GEMrawobject* Tree(int RSCindex)
  38.        Return a pointer to the given tree in the GEMrsc.  This is used
  39.        by classes such as GEMform.
  40.  
  41.      char* String(int RSCindex)
  42.        Return a pointer to the given string in the GEMrsc.  This is used
  43.        by classes such as GEMalert.
  44.  
  45.      int operator!()
  46.        Returns 1 (TRUE) if the GEMrsc failed to be created (because the
  47.        RSC file could not be loaded).
  48.  
  49.      void ChangeColours(int changer(int in_form, int from))
  50.        Pass every colour in the GEMrsc to the given function and replace
  51.        it with the returned value.  The RSCindex of the form in which
  52.        the colour occurs is also passed, so the function may react
  53.        differently for the same colour in different forms.
  54.  
  55. EXAMPLE
  56.      GEMrsc rsc("foo.rsc");
  57.      if (!rsc) {
  58.          GEMalert oh_dear("Cannot load file:|foo.rsc","quit|ciao");
  59.          oh_dear.Alert(0);
  60.      } else {
  61.           ...
  62.      }
  63.  
  64. SEE ALSO
  65.      GEMform, GEMalert, GEMformwindow, GEMmenu
  66.  
  67. BUGS
  68.      Bugs in GEM++ should be reported to warwick@cs.uq.oz.au
  69.  
  70. AUTHOR
  71.      Warwick Allison, 1993.
  72.      warwick@cs.uq.oz.au
  73.  
  74. COPYING
  75.      This functionality is part of the GEM++ library,
  76.      and is Copyright 1993 by Warwick W. Allison.
  77.  
  78.      GEM++ is free and protected under the GNU Library General Public
  79.      License.
  80.  
  81.      You are free to copy and modify these sources, provided you
  82.      acknowledge the origin by retaining this notice, and adhere to
  83.      the conditions described in the GNU LGPL.
  84.